ccw_Types.h

Go to the documentation of this file.

// File Revision
// Rev 1.01
//
// - rel 1.00: first release
//
// - rel 1.01: Add CashDrawerType
//- rel 1.03: Add new barcode type supported


// NOTE: Please DO NOT EDIT THIS FILE



#ifndef _CCW_TYPES_H__
#define _CCW_TYPES_H__

#include "ccw_Error.h"
#include "WinTypes.h"
#include "WinBase.h"
#include <stdint.h>

#pragma pack(1)

// Common define

#define MAXCHARBUFFER                   1024        

typedef char            int8;
typedef short           int16;
typedef int             int32;
typedef unsigned char   uint8;
typedef unsigned short  uint16;
typedef unsigned int    uint32;



/**********************************************************/
// Enum
/**********************************************************/

typedef enum : uint8
{
    CCW_LOG_DISABLED = 0,

    CCW_LOG_FATAL = 1,

    CCW_LOG_ERROR = 2,

    CCW_LOG_WARNING = 3,

    CCW_LOG_INFO = 4,

    CCW_LOG_FUNCTIONS = 5,

    CCW_LOG_DEBUG = 6,

    CCW_LOG_DEEP_DEBUG = 7,

} CcwLogVerbosity;

typedef enum : BYTE
{
    MONOCHROMATIC_1BIT = 0,

    GREYSCALE_8BIT = 1,

    RGB_24BIT = 2,

} RAWBitDepth;

typedef enum : BYTE
{
    USB_INT_PRINTER = 0,

} UsbInterfaceType;

typedef enum : BYTE
{
    COMMTYPE_USB = 1,

    COMMTYPE_COM = 2,

    COMMTYPE_NET = 3,

    COMMTYPE_OTHER = 0xFF,

} CommunicationPortType;

typedef enum : BYTE
{
    FONT_SIZE_X1 = 0,
    FONT_SIZE_X2 = 1,
    FONT_SIZE_X3 = 2,
    FONT_SIZE_X4 = 3,
    FONT_SIZE_X5 = 4,
    FONT_SIZE_X6 = 5,
    FONT_SIZE_X7 = 6,
    FONT_SIZE_X8 = 7,

} FontSize;

typedef enum : BYTE
{
    FONT_JUSTIFICATION_LEFT = 0,
    FONT_JUSTIFICATION_CENTER = 1,
    FONT_JUSTIFICATION_RIGHT = 2,

} FontJustification;

typedef enum : BYTE
{
    FONT_TYPE_1 = 0,
    FONT_TYPE_2 = 1,
    FONT_TYPE_3 = 2,
    FONT_TYPE_4 = 3,

} FontType;

typedef enum : BYTE
{
    FONT_CS_DEFAULT = 0,

} FontInternationalCharset;

typedef enum : BYTE
{

    CUT_TOTAL = 0,
    CUT_PARTIAL = 1

} CutType;

typedef enum : BYTE
{

    EJ_EJECT = 0,
    EJ_RETRACT = 1,

} EjectType;

typedef enum : BYTE
{
    PALIGN_PRINT = 0,
    PALIGN_CUT = 1,

} PaperAlignType;

typedef enum : BYTE
{
    CASH_DRAWER_1 = 0,
    CASH_DRAWER_2 = 1,

} CashDrawerType;


typedef enum : BYTE
{
    IMAGE_SCALE_NONE = 0,
    IMAGE_SCALE_TO_FIT = 1,
    IMAGE_SCALE_TO_WIDTH = 2,

} ImageScale;

typedef enum : BYTE
{
    IMAGE_ALIGN_TO_LEFT = 0,
    IMAGE_ALIGN_TO_CENTER = 1,
    IMAGE_ALIGN_TO_RIGHT = 2,

} ImageAlign;

typedef enum : BYTE
{
    IMAGE_GRMODE_DITHERING = 0,
    IMAGE_GRMODE_THRESHOLD = 1,

} ImageGRMode;

typedef enum : BYTE
{
    BARCODE_HRI_NONE = 0,
    BARCODE_HRI_TOP = 1,
    BARCODE_HRI_BOTTOM = 2,
    BARCODE_HRI_TOPBOTTOM = 3,

} BarcodeHRIPosition;

typedef enum : BYTE
{
    BARCODE_ALIGN_TO_LEFT = 0,
    BARCODE_ALIGN_TO_CENTER = 1,
    BARCODE_ALIGN_TO_RIGHT = 2,

} BarcodeAlign;

typedef enum : WORD
{
    BARCODE_TYPE_NONE = 0,

    //************************************************************************************************
    // STATIC CONST : BARCODE 1D TYPE
    //************************************************************************************************

    BARCODE_TYPE_CODABAR = 1,
    BARCODE_TYPE_UPCA = 2,
    BARCODE_TYPE_UPCE = 3,
    BARCODE_TYPE_EAN13 = 4,
    BARCODE_TYPE_EAN8 = 5,
    BARCODE_TYPE_CODE39 = 6,
    BARCODE_TYPE_ITF = 7,
    BARCODE_TYPE_CODE93 = 8,
    BARCODE_TYPE_CODE128 = 9,
    BARCODE_TYPE_CODE32 = 10,
    BARCODE_TYPE_EAN128 = 11,

    //************************************************************************************************
    // STATIC CONST : BARCODE 2D TYPE
    //************************************************************************************************

    BARCODE_TYPE_QRCODE = 1001,

    BARCODE_TYPE_PDF417 = 1002,

    BARCODE_TYPE_DATAMATRIX = 1003,

    BARCODE_TYPE_AZTEC = 1004,
    BARCODE_TYPE_MAXICODE = 1005,

} BarcodeType;

typedef enum : DWORD
{
    COM_SETT_BAUDRATE_AUTO = 0,

    COM_SETT_BAUDRATE_1200 = 1200,

    COM_SETT_BAUDRATE_2400 = 2400,

    COM_SETT_BAUDRATE_4800 = 4800,

    COM_SETT_BAUDRATE_9600 = 9600,
    
    COM_SETT_BAUDRATE_19200 = 19200,

    COM_SETT_BAUDRATE_38400 = 38400,

    COM_SETT_BAUDRATE_57600 = 57600,

    COM_SETT_BAUDRATE_115200 = 115200,

} Com_Settings_Baudrate;

typedef enum : BYTE
{
    COM_SETT_PARITY_NONE = NOPARITY,

    COM_SETT_PARITY_ODD = ODDPARITY,

    COM_SETT_PARITY_EVEN = EVENPARITY,

} Com_Settings_Parity;

typedef enum : BYTE
{
    COM_SETT_NBITS_8 = 8,

    COM_SETT_NBITS_7 = 7,

} Com_Settings_NBits;

typedef enum : BYTE
{
    COM_SETT_STOPBITS_1 = ONESTOPBIT,

    COM_SETT_STOPBITS_2 = TWOSTOPBITS,

} Com_Settings_StopBits;

typedef enum : BYTE
{
    COM_SETT_FLOW_CONTROL_NONE = 0,

    COM_SETT_FLOW_CONTROL_HW = 1,

    COM_SETT_FLOW_CONTROL_XONXOFF = 2,

} Com_Settings_FlowControl;

typedef enum : BYTE
{
    CUTS_COUNTER = 0,
    
    CUT_ERRORS = 1,
    
    PRINTED_LENGTH_DM = 2,

} ClearableField;

typedef enum : BYTE
{
    TP_TRANSACTION_REC = 0,

    TP_TRANSACTION_STOP = 1,

    TP_TRANSACTION_PRINT = 2,

    TP_TRANSACTION_CLEAN = 3,

} TrPrintMode;

typedef enum : BYTE
{
    TXRX        = 0x01,

    STS         = 0x02,

    TXRX_STS    = 0x03,

} OpenDeviceMode;

typedef enum : BYTE
{
    HEAD_TEMPERATURE    = 0x10,

    NUM_POWERON         = 0x11,

    POWER_VOLTAGE       = 0x12,

    NUM_CUTS            = 0x13,

    NUM_RETRACT         = 0x14,

    TOTAL_PAPER_REM     = 0x15,

    PAPER_PRINTED       = 0x16, 

    NUM_COVER_OPEN      = 0x17,

} DevCounterType;

/****************************** Structures ******************/

typedef struct {

    wchar_t cPrinterName[MAXCHARBUFFER];

    BOOL bPrinterOnline;

    BOOL bDefaultPrinter;

    BYTE reserved[10240];
} PrinterStruct;

typedef struct {

    WORD wVID;

    WORD wPID;  

    char cSerialNumber[MAXCHARBUFFER];

    char cPrinterName[MAXCHARBUFFER];

    UsbInterfaceType uIntType;

    BYTE reserved[2043];
} USBDeviceStruct;

typedef struct {

    char cIPAddress[MAXCHARBUFFER];

    int dwIPPort;

    char cMACAddress[MAXCHARBUFFER];

    char cDeviceName[MAXCHARBUFFER];

    BYTE reserved[2048];
} ETHDeviceStruct;

typedef struct {

    char cCOMPort[MAXCHARBUFFER];   

    Com_Settings_Baudrate cBaudrate;

    Com_Settings_Parity cParity;

    Com_Settings_NBits cNBits;

    Com_Settings_StopBits cStopBits;

    Com_Settings_FlowControl cFlowControl;

    BYTE reserved[2048];
} COMPortStruct;

typedef struct {

    FontSize charWidth; 

    FontSize charHeight;

    FontJustification justification;

    FontType charFontType;                              

    FontInternationalCharset interCharSet;

    BYTE bLineSpacing;

    BOOL italic;

    BOOL emphasized;

    BOOL underline;

    WORD printWidth;

    WORD leftMarginValue;

    BYTE reserved[1024];

} PrintFontStruct;
#define PRINTFONTSTRUCT_INIT { FONT_SIZE_X1, FONT_SIZE_X1, FONT_JUSTIFICATION_LEFT, FONT_TYPE_1, FONT_CS_DEFAULT, 64, false,false,false , 0, 0, {0}}

typedef struct {

    ImageAlign imageAlignMode;

    DWORD leftMarginValue;  

    DWORD printScaleWidthValue;

    ImageScale printScaleMode;

    BYTE reserved[1023];
} PrintImageStruct;

#define PRINTIMAGESTRUCT_INIT { IMAGE_ALIGN_TO_LEFT, 0, 0 , IMAGE_SCALE_NONE,  {0}}

typedef struct {
    

    DWORD leftMarginValue;

    DWORD dwBarcodeWidth;

    DWORD dwBarcodeHeight;

    BarcodeAlign brcAlignMode;

    BarcodeHRIPosition brcHRIPosition;  

    BarcodeType brcType;

    BYTE reserved[1023];
} PrintBarcodeStruct;

#define PRINTBARCODESTRUCT_INIT {0, 0,0, BARCODE_ALIGN_TO_LEFT,BARCODE_HRI_BOTTOM, BARCODE_TYPE_NONE, {0}}


typedef struct {
    

    char SERIAL_NUMBER[17];    // 16 plus terminator
    unsigned long CUT_COUNTER;
    unsigned long CUT_ERRORS;
    unsigned long POWER_ON_COUNTER;
    unsigned long AUTOLOAD_COUNTER;
    unsigned long COVER_OPEN_COUNTER;
    unsigned long HIGH_VOLT_COUNTER;
    unsigned long LOW_VOLT_COUNTER;
    unsigned long OVERTEMP_COUNTER;
    unsigned long POWER_FAIL_COUNTER;
    unsigned long PRINTED_DM_COUNTER;

    uint8_t reserved[1023];
} PrinterStatisticsStruct;

#define PRINTERSTATISTICSSTRUCT_INIT {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

#pragma pack()

#endif